<!DOCTYPE html>
<html>
  <head>
    <meta charset='utf-8'>
    <meta content='width=device-width, initial-scale=1.0' name='viewport'>
    <meta content='' name='description'>
    <meta content='Nils Nordman' name='author'>
    <link href='/images/howl.png' rel='shortcut icon'>
    <title>Howl :: Spec - howl.Project</title>
    <link href="/stylesheets/bootstrap.min.css" media="screen" rel="stylesheet" type="text/css" />
    <link href="/stylesheets/syntax.css" media="screen" rel="stylesheet" type="text/css" />
    <link href="/stylesheets/howl.css" media="screen" rel="stylesheet" type="text/css" />
    <link href='//fonts.googleapis.com/css?family=Josefin+Slab' rel='stylesheet' type='text/css'>
    <link href='//fonts.googleapis.com/css?family=Open+Sans+Condensed:700' rel='stylesheet' type='text/css'>
  </head>
  <body class='doc doc_spec doc_spec_project_spec'>
    <div class='container'>
      <div class='masthead'>
        <ul class='nav nav-pills'>
          <li>
            <a href='/'>
              <span class='glyphicon glyphicon-home'></span>
              Home
            </a>
          </li>
          <li>
            <a href='/doc/'>
              <span class='glyphicon glyphicon-book'></span>
              Documentation
            </a>
          </li>
          <li>
            <a href='/blog/'>
              <span class='glyphicon glyphicon-bullhorn'></span>
              Blog
            </a>
          </li>
          <li>
            <a href='/contact.html'>
              <span class='glyphicon glyphicon-inbox'></span>
              Contact
            </a>
          </li>
        </ul>
      </div>
      <ol class="breadcrumb"><li><a href="/">Home</a></li><li><a href='../'>Howl 0.3 Documentation</a></li><li>Spec</li><li>Spec - howl.Project</li></ol>
      <div class="spec-group spec-group-1">&#x000A;&#x000A;<h1 id="howl.project">howl.Project</h1>&#x000A;&#x000A;<pre class="highlight moonscript"><code><span class="n">after_each</span><span class="w"> </span><span class="o">-&gt;</span><span class="w">&#x000A;  </span><span class="nc">Project</span><span class="p">.</span><span class="n">roots</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{}</span><span class="w">&#x000A;  </span><span class="nc">Project</span><span class="p">.</span><span class="n">open</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{}</span></code></pre>&#x000A;&#x000A;&#x000A;<h4 id=".roots-contains-all-known-roots">.roots contains all known roots</h4>&#x000A;&#x000A;<pre class="highlight moonscript"><code><span class="n">assert</span><span class="p">.</span><span class="n">same</span><span class="w"> </span><span class="p">{},</span><span class="w"> </span><span class="nc">Project</span><span class="p">.</span><span class="n">roots</span><span class="w">&#x000A;</span><span class="n">with_tmpdir</span><span class="w"> </span><span class="p">(</span><span class="n">dir</span><span class="p">)</span><span class="w"> </span><span class="o">-&gt;</span><span class="w">&#x000A;  </span><span class="nc">Project</span><span class="p">.</span><span class="n">add_root</span><span class="w"> </span><span class="n">dir</span><span class="w">&#x000A;  </span><span class="n">assert</span><span class="p">.</span><span class="n">same</span><span class="w"> </span><span class="p">{</span><span class="n">dir</span><span class="p">},</span><span class="w"> </span><span class="nc">Project</span><span class="p">.</span><span class="n">roots</span></code></pre>&#x000A;&#x000A;&#x000A;<h4 id=".add_root-adds-the-given-root-if-not-already-present">.add_root adds the given root if not already present</h4>&#x000A;&#x000A;<pre class="highlight moonscript"><code><span class="n">with_tmpdir</span><span class="w"> </span><span class="p">(</span><span class="n">dir</span><span class="p">)</span><span class="w"> </span><span class="o">-&gt;</span><span class="w">&#x000A;  </span><span class="nc">Project</span><span class="p">.</span><span class="n">add_root</span><span class="w"> </span><span class="n">dir</span><span class="w">&#x000A;  </span><span class="nc">Project</span><span class="p">.</span><span class="n">add_root</span><span class="w"> </span><span class="n">dir</span><span class="w">&#x000A;  </span><span class="n">assert</span><span class="p">.</span><span class="n">equal</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="o">#</span><span class="nc">Project</span><span class="p">.</span><span class="n">roots</span></code></pre>&#x000A;&#x000A;&#x000A;<h4 id=".remove_root-removes-the-given-root">.remove_root removes the given root</h4>&#x000A;&#x000A;<pre class="highlight moonscript"><code><span class="n">with_tmpdir</span><span class="w"> </span><span class="p">(</span><span class="n">dir</span><span class="p">)</span><span class="w"> </span><span class="o">-&gt;</span><span class="w">&#x000A;  </span><span class="nc">Project</span><span class="p">.</span><span class="n">add_root</span><span class="w"> </span><span class="n">dir</span><span class="w">&#x000A;  </span><span class="nc">Project</span><span class="p">.</span><span class="n">remove_root</span><span class="w"> </span><span class="n">dir</span><span class="w">&#x000A;  </span><span class="n">assert</span><span class="p">.</span><span class="n">equal</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w"> </span><span class="o">#</span><span class="nc">Project</span><span class="p">.</span><span class="n">roots</span></code></pre>&#x000A;&#x000A;<div class="spec-group spec-group-2">&#x000A;&#x000A;<h2 id=".for_file">.for_file<span class="arg-list">(file)</span></h2>&#x000A;&#x000A;<h4 id="raises-an-error-if-file-is-nil">raises an error if file is nil</h4>&#x000A;&#x000A;<pre class="highlight moonscript"><code><span class="n">assert</span><span class="p">.</span><span class="n">raises</span><span class="w"> </span><span class="s1">'file'</span><span class="p">,</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="nc">Project</span><span class="p">.</span><span class="n">for_file</span><span class="w"> </span><span class="kc">nil</span></code></pre>&#x000A;&#x000A;&#x000A;<h4 id="returns-nil-by-default">returns nil by default</h4>&#x000A;&#x000A;<pre class="highlight moonscript"><code><span class="nc">File</span><span class="p">.</span><span class="n">with_tmpfile</span><span class="w"> </span><span class="p">(</span><span class="n">file</span><span class="p">)</span><span class="w"> </span><span class="o">-&gt;</span><span class="w">&#x000A;  </span><span class="n">assert</span><span class="p">.</span><span class="n">is_nil</span><span class="w"> </span><span class="nc">Project</span><span class="p">.</span><span class="n">for_file</span><span class="w"> </span><span class="n">file</span></code></pre>&#x000A;&#x000A;<div class="spec-group spec-group-3">&#x000A;&#x000A;<h3 id=""><span class="arg-list">(when there is VC found for the file)</span></h3>&#x000A;&#x000A;<pre class="highlight moonscript"><code><span class="n">vc</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="ss">name:</span><span class="w"> </span><span class="s1">'vc'</span><span class="p">,</span><span class="w"> </span><span class="ss">root:</span><span class="w"> </span><span class="s1">'foo_root'</span><span class="p">,</span><span class="w"> </span><span class="ss">files:</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="p">{}</span><span class="w">&#x000A;</span><span class="n">before_each</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="nc">VC</span><span class="p">.</span><span class="n">register</span><span class="w"> </span><span class="s1">'vc'</span><span class="p">,</span><span class="w"> </span><span class="ss">find:</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="n">vc</span><span class="w">&#x000A;</span><span class="n">after_each</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="nc">VC</span><span class="p">.</span><span class="n">unregister</span><span class="w"> </span><span class="s1">'vc'</span></code></pre>&#x000A;&#x000A;&#x000A;<h4 id="returns-a-project-instantiated-with-the-vc-and-vc-root">returns a project instantiated with the vc and vc root</h4>&#x000A;&#x000A;<pre class="highlight moonscript"><code><span class="n">p</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nc">Project</span><span class="p">.</span><span class="n">for_file</span><span class="w"> </span><span class="s1">'file'</span><span class="w">&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">not_nil</span><span class="w"> </span><span class="n">p</span><span class="w">&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">equal</span><span class="w"> </span><span class="n">p</span><span class="p">.</span><span class="n">root</span><span class="p">,</span><span class="w"> </span><span class="n">vc</span><span class="p">.</span><span class="n">root</span><span class="w">&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">equal</span><span class="w"> </span><span class="n">p</span><span class="p">.</span><span class="n">vc</span><span class="p">,</span><span class="w"> </span><span class="n">vc</span></code></pre>&#x000A;&#x000A;&#x000A;<h4 id="adds-the-new-root-to-.roots">adds the new root to .roots</h4>&#x000A;&#x000A;<pre class="highlight moonscript"><code><span class="nc">Project</span><span class="p">.</span><span class="n">for_file</span><span class="w"> </span><span class="s1">'file'</span><span class="w">&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">same</span><span class="w"> </span><span class="nc">Project</span><span class="p">.</span><span class="n">roots</span><span class="p">,</span><span class="w"> </span><span class="p">{</span><span class="n">vc</span><span class="p">.</span><span class="n">root</span><span class="p">}</span></code></pre>&#x000A;&#x000A;&#x000A;<h4 id="adds-a-new-entry-for-the-root-and-project-to-.open">adds a new entry for the root and project to .open</h4>&#x000A;&#x000A;<pre class="highlight moonscript"><code><span class="n">p</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nc">Project</span><span class="p">.</span><span class="n">for_file</span><span class="w"> </span><span class="s1">'file'</span><span class="w">&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">same</span><span class="w"> </span><span class="nc">Project</span><span class="p">.</span><span class="n">open</span><span class="p">,</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="p">[</span><span class="n">vc</span><span class="p">.</span><span class="n">root</span><span class="p">]:</span><span class="w"> </span><span class="n">p</span><span class="w"> </span><span class="p">}</span></code></pre>&#x000A;&#x000A;</div>&#x000A;<div class="spec-group spec-group-3">&#x000A;&#x000A;<h3 id=""><span class="arg-list">(when there is a known root containing the file)</span></h3>&#x000A;&#x000A;<h4 id="returns-a-new-project-for-the-root">returns a new project for the root</h4>&#x000A;&#x000A;<pre class="highlight moonscript"><code><span class="n">with_tmpdir</span><span class="w"> </span><span class="p">(</span><span class="n">dir</span><span class="p">)</span><span class="w"> </span><span class="o">-&gt;</span><span class="w">&#x000A;  </span><span class="nc">Project</span><span class="p">.</span><span class="n">add_root</span><span class="w"> </span><span class="n">dir</span><span class="w">&#x000A;  </span><span class="n">file</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">dir</span><span class="w"> </span><span class="o">/</span><span class="w"> </span><span class="s1">'test.moon'</span><span class="w">&#x000A;  </span><span class="n">p</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nc">Project</span><span class="p">.</span><span class="n">for_file</span><span class="w"> </span><span class="n">file</span><span class="w">&#x000A;  </span><span class="n">assert</span><span class="p">.</span><span class="n">not_nil</span><span class="w"> </span><span class="n">p</span><span class="w">&#x000A;  </span><span class="n">assert</span><span class="p">.</span><span class="n">equal</span><span class="w"> </span><span class="n">p</span><span class="p">.</span><span class="n">root</span><span class="p">,</span><span class="w"> </span><span class="n">dir</span></code></pre>&#x000A;&#x000A;&#x000A;<h4 id="automatically-sets-the-matching-vc-if-possible">automatically sets the matching VC if possible</h4>&#x000A;&#x000A;<pre class="highlight moonscript"><code><span class="n">with_tmpdir</span><span class="w"> </span><span class="p">(</span><span class="n">dir</span><span class="p">)</span><span class="w"> </span><span class="o">-&gt;</span><span class="w">&#x000A;  </span><span class="nc">Project</span><span class="p">.</span><span class="n">add_root</span><span class="w"> </span><span class="n">dir</span><span class="w">&#x000A;  </span><span class="n">file</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">dir</span><span class="w"> </span><span class="o">/</span><span class="w"> </span><span class="s1">'test.moon'</span><span class="w">&#x000A;  </span><span class="n">vc</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="ss">name:</span><span class="w"> </span><span class="s1">'vc'</span><span class="p">,</span><span class="w"> </span><span class="ss">root:</span><span class="w"> </span><span class="n">dir</span><span class="p">,</span><span class="w"> </span><span class="ss">files:</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="p">{}</span><span class="w">&#x000A;  </span><span class="nc">VC</span><span class="p">.</span><span class="n">register</span><span class="w"> </span><span class="s1">'vc'</span><span class="p">,</span><span class="w"> </span><span class="ss">find:</span><span class="w"> </span><span class="p">(</span><span class="n">file</span><span class="p">)</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="n">vc</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">file</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="n">file</span><span class="w">&#x000A;  </span><span class="n">p</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nc">Project</span><span class="p">.</span><span class="n">for_file</span><span class="w"> </span><span class="n">file</span><span class="w">&#x000A;  </span><span class="nc">VC</span><span class="p">.</span><span class="n">unregister</span><span class="w"> </span><span class="s1">'vc'</span><span class="w">&#x000A;  </span><span class="n">assert</span><span class="p">.</span><span class="n">equal</span><span class="w"> </span><span class="n">p</span><span class="p">.</span><span class="n">vc</span><span class="p">,</span><span class="w"> </span><span class="n">vc</span></code></pre>&#x000A;&#x000A;</div>&#x000A;<div class="spec-group spec-group-3">&#x000A;&#x000A;<h3 id=""><span class="arg-list">(when there is an open project containing the file)</span></h3>&#x000A;&#x000A;<h4 id="returns-the-existing-project">returns the existing project</h4>&#x000A;&#x000A;<pre class="highlight moonscript"><code><span class="n">with_tmpdir</span><span class="w"> </span><span class="p">(</span><span class="n">dir</span><span class="p">)</span><span class="w"> </span><span class="o">-&gt;</span><span class="w">&#x000A;  </span><span class="nc">Project</span><span class="p">.</span><span class="n">add_root</span><span class="w"> </span><span class="n">dir</span><span class="w">&#x000A;  </span><span class="n">file</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">dir</span><span class="w"> </span><span class="o">/</span><span class="w"> </span><span class="s1">'test.moon'</span><span class="w">&#x000A;  </span><span class="n">file2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">dir</span><span class="w"> </span><span class="o">/</span><span class="w"> </span><span class="s1">'test2.moon'</span><span class="w">&#x000A;  </span><span class="n">p</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nc">Project</span><span class="p">.</span><span class="n">for_file</span><span class="w"> </span><span class="n">file</span><span class="w">&#x000A;  </span><span class="n">p2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nc">Project</span><span class="p">.</span><span class="n">for_file</span><span class="w"> </span><span class="n">file</span><span class="w">&#x000A;  </span><span class="n">assert</span><span class="p">.</span><span class="n">not_nil</span><span class="w"> </span><span class="n">p</span><span class="w">&#x000A;  </span><span class="n">assert</span><span class="p">.</span><span class="n">equal</span><span class="w"> </span><span class="n">p2</span><span class="p">,</span><span class="w"> </span><span class="n">p</span></code></pre>&#x000A;&#x000A;</div>&#x000A;</div>&#x000A;<div class="spec-group spec-group-2">&#x000A;&#x000A;<h2 id="for-a-given-project-instance">for a given project instance</h2>&#x000A;<div class="spec-group spec-group-3">&#x000A;&#x000A;<h3 id=".files">.files<span class="arg-list">()</span></h3>&#x000A;&#x000A;<h4 id="delegates-to-.vc.files()-if-it-is-available">delegates to .vc.files() if it is available</h4>&#x000A;&#x000A;<pre class="highlight moonscript"><code><span class="n">vc</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="ss">files:</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="s1">'files'</span><span class="w">&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">equal</span><span class="w"> </span><span class="n">vc</span><span class="p">.</span><span class="n">files</span><span class="o">!</span><span class="p">,</span><span class="w"> </span><span class="nc">Project</span><span class="p">(</span><span class="s1">'root'</span><span class="p">,</span><span class="w"> </span><span class="n">vc</span><span class="p">)</span><span class="o">\</span><span class="n">files</span><span class="o">!</span></code></pre>&#x000A;&#x000A;&#x000A;<h4 id="falls-back-to-a-fs-scan,-skipping-directories-and-hidden-and-backup-files">falls back to a FS scan, skipping directories and hidden and backup files</h4>&#x000A;&#x000A;<pre class="highlight moonscript"><code><span class="n">with_tmpdir</span><span class="w"> </span><span class="p">(</span><span class="n">dir</span><span class="p">)</span><span class="w"> </span><span class="o">-&gt;</span><span class="w">&#x000A;  </span><span class="n">regular</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">dir</span><span class="w"> </span><span class="o">/</span><span class="w"> </span><span class="s1">'regular.lua'</span><span class="w">&#x000A;  </span><span class="n">regular</span><span class="o">\</span><span class="n">touch</span><span class="o">!</span><span class="w">&#x000A;  </span><span class="n">sub_dir</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">dir</span><span class="w"> </span><span class="o">/</span><span class="w"> </span><span class="s1">'sub_dir'</span><span class="w">&#x000A;  </span><span class="n">sub_dir</span><span class="o">\</span><span class="n">mkdir</span><span class="o">!</span><span class="w">&#x000A;  </span><span class="n">hidden</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">dir</span><span class="w"> </span><span class="o">/</span><span class="w"> </span><span class="s1">'.config'</span><span class="w">&#x000A;  </span><span class="n">hidden</span><span class="o">\</span><span class="n">touch</span><span class="o">!</span><span class="w">&#x000A;  </span><span class="n">backup</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">dir</span><span class="w"> </span><span class="o">/</span><span class="w"> </span><span class="s1">'config~'</span><span class="w">&#x000A;  </span><span class="n">backup</span><span class="o">\</span><span class="n">touch</span><span class="o">!</span><span class="w">&#x000A;  </span><span class="n">assert</span><span class="p">.</span><span class="n">same</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="n">regular</span><span class="p">.</span><span class="n">path</span><span class="w"> </span><span class="p">},</span><span class="w"> </span><span class="p">[</span><span class="n">f</span><span class="p">.</span><span class="n">path</span><span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="n">f</span><span class="w"> </span><span class="k">in</span><span class="w"> </span><span class="o">*</span><span class="nc">Project</span><span class="p">(</span><span class="n">dir</span><span class="p">)</span><span class="o">\</span><span class="n">files</span><span class="o">!</span><span class="p">]</span></code></pre>&#x000A;&#x000A;</div>&#x000A;</div>&#x000A;</div>
      <div class='footer text-muted'>
        <a href='/'>
          <img width="50" height="50" class="footer-logo" src="/images/howl.png" />
        </a>
        <div class='footer-follow'>
          <p>
            <a class='twitter-follow-button' data-lang='en' data-show-count='false' href='https://twitter.com/howleditor' rel='me'>
              Follow @howleditor
            </a>
          </p>
          <p>
            <a class='twitter-share-button' data-count='none' data-hashtags='howleditor' data-lang='en' data-text='The Howl Editor, a general purpose, light-weight customizable editor.' data-url='http://howl.io' href='https://twitter.com/share'>
              Tweet
            </a>
          </p>
        </div>
        <div class='footer-blurb'>
          <div>The Howl editor.</div>
          <div>
            Copyright 2012-2015
            <a class='alert-link' href='https://github.com/nilnor/howl/contributors'>
              The Howl Developers.
            </a>
          </div>
        </div>
      </div>
    </div>
    <script>
      <!-- / GA -->
      (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
      (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
      m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
      })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
      ga('create', 'UA-45283282-1', 'howl.io');
      ga('send', 'pageview');
      <!-- / Twitter -->
      !function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0];
      if(!d.getElementById(id)){js=d.createElement(s);js.id=id;
      js.src="//platform.twitter.com/widgets.js";
      fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");
    </script>
  </body>
</html>
